Translating an external workbench/de

Other languages:

In den folgenden Beschreibungen steht "context" für den Namen deines Addons oder deines Arbeitsbereichs, z.B. "MeinSuperAddon" oder "DraftPlus" oder was auch immer. Groß- und Kleinschreibung wird hier unterschieden: So ist z.B. "Context" ist nicht dasselbe wie "context". Dieser "context" sorgt dafür, dass alle Übersetzungen des Codes unter demselben Namen zusammengefasst werden, um von Übersetzern leichter erkannt zu werden. Das heißt, sie wissen genau, zu welchem Addon oder welchem Arbeitsbereich eine bestimmte Zeichenfolge gehört.

Hinweis: Hier gibt es ein Multifunktionsskript, das den kompletten unten beschriebenen Ablauf automatisiert (Es wird trotzdem empfohlen, die Beschreibung zu lesen, um zu wissen, was das Skript erledigen soll): https://github.com/yorikvanhavre/BIM_Workbench/blob/master/utils/updateTranslations.py

Die Quellen vorbereiten

Allgemeines

In jeder Python-Datei

import FreeCAD
translate = FreeCAD.Qt.translate

print("My text")
wird zu:
print(translate("context", "My text"))
Man darf nicht vergessen, dass translate() nicht nur eine normale Funktion ist, sondern auch als "Tag" für das Textverabeitungs-Dienstprogramm lupdate dient und deshalb exakt "translate" heißen muss. Das Programm lupdate ist eine einfache Textverarbeitung; es führt keinen Code aus. Zeichenketteninhalte müssen direkt an die Funktion translate() übergeben werden: Es können keine Variablen, Konstanten usw. übergeben werden. Ein Beispiel:
# This works:
FreeCAD.Console.PrintMessage(translate("context", "My text") + "\n")

# This does not, lupdate only sees the word "a_variable", and doesn't know what that is:
a_variable = "My text"
FreeCAD.Console.PrintMessage(translate("context", a_variable ) + "\n")

# But this works -- a_variable will contain the translated string:
a_variable = translate("context", "My text")
FreeCAD.Console.PrintMessage(a_variable  + "\n")
Dies kann überall verwendet werden: In print(), in FreeCAD.Console.PrintMessage(), in Qt-Dialogen, etc. Die FreeCAD.Console-Funktionen fügen das Zeichen für den Zeilenumbruch (\n) nicht automatisch hinzu, es muss bei Bedarf am Ende hinzugefügt werden. Dieses Zeichen benötigt auch keine Übersetzung und kann daher außerhalb der Übersetzungsfunktion liegen:
FreeCAD.Console.PrintMessage(translate("context", "My text") + "\n")

obj.addProperty("App::PropertyBool", "MyProperty", "PropertyGroup", QT_TRANSLATE_NOOP("App::Property", "This is what My Property does"))
Man verwendet in diesem speziellen Fall keinen eigenen "context", sondern behält "App::Property" bei.

In Der Datei InitGui.py

def QT_TRANSLATE_NOOP(context, text):
    return text
Das Makro QT_TRANSLATE_NOOP macht nichts außer, dass es Texte markiert, die später vom Dienstprogramm lupdate aufgesammelt werden. Es wird nur in Sonderfällen verwendet, in denen sich FreeCAD selbst um alles kümmert.
self.appendMenu(QT_TRANSLATE_NOOP("Workbench", "My menu"), [list of commands, ...])
self.appendToolbar(QT_TRANSLATE_NOOP("Workbench", "My toolbar"), [list of commands, ...])

FreeCADGui.addLanguagePath("/path/to/translations")
FreeCADGui.updateLocale()

Die Datei InitGui.py hat kein Attribut file, so dass es nicht einfach ist, die relative Position des Übersetzungsordners zu finden. Eine einfache Möglichkeit, dies zu umgehen, besteht darin, eine andere Datei aus demselben Ordner zu importieren und in dieser Datei Folgendes zu tun: 

FreeCADGui.addLanguagePath(os.path.join(os.path.dirname(__file__), "translations"))
FreeCADGui.updateLocale()

Innerhalb jeder FreeCAD-Befehlsklasse

def QT_TRANSLATE_NOOP(context, text):
    return text

def GetResources(self):
    return {'Pixmap'  : "path/to/icon.svg"),
            'MenuText': QT_TRANSLATE_NOOP("CommandName", "My Command"),
            'ToolTip' : QT_TRANSLATE_NOOP("CommandName", "Describes what the command does"),
            'Accel'   : "Shift+A"
    }
wobei "CommandName" der Name des Befehls ist, definiert durch:
FreeCADGui.addCommand('CommandName', My_Command_Class())

Alle Zeichenketten des eigenen Moduls sammeln

lupdate *.ui -ts translations/uifiles.ts
Dies ist rekursiv und findet .ui-Dateien in der gesamten Verzeichnisstruktur.
pylupdate *.py -ts translations/pyfiles.ts

lconvert -i translations/uifiles.ts translations/pyfiles.ts -o translations/MyModule.ts

#!/bin/sh
lupdate *.ui -ts translations/uifiles.ts
pylupdate *.py -ts translations/pyfiles.ts
lconvert -i translations/uifiles.ts translations/pyfiles.ts -o translations/MyModule.ts
rm translations/pyfiles.ts
rm translations/uifiles.ts

Die .ts-Datei an eine Übersetzungsplattform senden

Es ist an der Zeit, die .ts-Datei übersetzen zu lassen. Dafür kann man ein Konto auf einer öffentlichen Übersetzungsplattform wie Crowdin oder Transifex einrichten, oder unser bestehendes FreeCAD-Addons-Konto bei Crowdin nutzen, das bereits viele Benutzer hat und somit eine größere Chance, die Datei schnell übersetzen zu lassen, von Leuten, die FreeCAD kennen.

Soll die Datei auf dem FreeCAD-Crowdin-Konto untergebracht werden, hilft Yorik im FreeCAD-Forum gerne weiter.

Hinweis: Einige Plattformen wie Crowdin können sich in GitHub integrieren und den gesamten Prozess von Punkt 2, 3 und 4 automatisch durchführen. Dafür kann das FreeCAD-Crowdin-Konto nicht verwendet werden; Man muss sein eigenes Konto einrichten.

Die Übersetzungen zusammenführen

Sobald deine .ts Datei übersetzt wurde, wenn auch nur teilweise, kannst du die Übersetzungen von der Internetseite herunterladen:

Die Übersetzungen kompilieren

Nun wird das Programm lrelease auf jede vorhandene Datei angewendet: 

lrelease "translations/Draft_de.ts"
lrelease "translations/Draft_fr.ts"
lrelease "translations/Draft_pt-BR.ts"

Der Prozess lässt sich automatisieren: 

for f in translations/*_*.ts
do
    lrelease "translations/$f"
done

Es sollte jetzt eine .qm-Datei für jede übersetzte .ts-Datei vorhanden sein. Die .qm-Dateien sind die, die von Qt und FreeCAD zur Laufzeit verwendet werden.

Das ist alles, was gebraucht wird. Man beachte, dass bestimmte Teile des eigenen Arbeitsbereichs nicht sofort übersetzt werden können, wenn man sich für einen Wechsel der Sprache entscheidet. In diesem Fall muss FreeCAD neu gestartet werden, damit die neue Sprache verwendet wird.

Übersetzungen testen

  1. In FreeCAD zu einer Sprache wechseln, die man übersetzt hat (z.B. Deutsch)
  2. Die Übersetzung in FreeCAD laden, z.B. FreeCADGui.addTranslationPath("/Pfad/zum/Verzeichnis/mit/qmfile")
  3. Eine Zeichenkette testen, z.B. FreeCAD.Qt.translate("dein Kontext","Eine Zeichenkette")

Ergebnis: Dies sollte die deutsche Übersetzung liefern. Wenn das funktioniert, ist die Basiseinstellung OK. Dann können wir uns etwas anderes ansehen. Beispielsweise sollten Befehlsnamen einen speziellen Kontext benutzen, das ist der in FreeCAD eingetragene Befehlsname.

Wichtige Hinweise

Ein nützliches Skript

Yorik unterhält ein nützliches Skript für den Arbeitsbereich BIM, das .ts-Dateien sammeln, hochladen und herunterladen kann. Dieses Skript kann einfach kopiert und für den eigenen Arbeitsbereich angepasst werden:

https://github.com/yorikvanhavre/BIM_Workbench/blob/master/utils/updateTranslations.py

Technische Einzelheiten und erweiterte Anwendung

In den obigen Beispielen wurden zwei separate Funktionen verwendet: translate() und QT_TRANSLATE_NOOP. Vielleicht stößt man auch auf tr() und QT_TR_NOOP, die automatisch das Argument "context" basierend auf dem Ort, von wo sie aufgerufen werden, bereitstellen. Diese beiden Paare von Funktionen unterscheiden sich grundlegend.

translate() and tr() accomplish two separate tasks: at runtime they perform the actual translation from the string passed into them to the final translated string. This is true whether they are provided a literal string, or a variable, or a constant: the lookup is dynamic and real-time during the run of the code. However, they provide an additional non-runtime function: they are recognized by the pylupdate utility. If (and only if) they contain a string literal, that literal is extracted by the utility. ONLY string literals are extracted by pylupdate -- if a variable is passed it is ignored by the pylupdate utility. Qt will attempt to provide a translation at runtime, but this will only work if some other piece of code called one of the translation functions with the literal string that needs to be translated, so that pylupdate can extract it. Note that the code with the string literal need not actually ever execute, it must simply exist as a line of code in a file somewhere: pylupdate performs no analysis or code execution, it is simply performing a string search and extraction.

In contrast, QT_TRANSLATE_NOOP and QT_TR_NOOP do nothing at all at runtime: they are literal "no-ops", and are completely ignored by running code. Their only use is to mark a literal string for extraction by pylupdate: it never makes sense to place a variable within a call to one of these functions, it will have no effect. They are used in circumstances where translate() or tr() will be called with a variable containing the text to translate. For example, any code that is used to create a Command or a Property will use a NOOP-type function around the command menu text or tooltip, or the property docstring: at runtime when FreeCAD displays these items to the user it calls translate(): the literal strings must have been extracted by pylupdate at the point of creation, for example: 

def GetResources(self):
    return {'Pixmap'  : "path/to/icon.svg",
            'MenuText': QT_TRANSLATE_NOOP("CommandName", "My Command"),
            'ToolTip' : QT_TRANSLATE_NOOP("CommandName", "Describes what the command does"),
            'Accel'   : "Shift+A"
    }

In this usage, at runtime the dictionary returned by this function is literally: 

{ 
    'Pixmap'  : "path/to/icon.svg",
    'MenuText': "My Command",
    'ToolTip' : "Describes what the command does",
    'Accel'   : "Shift+A"
}

There is no reference to any type of translation information. When FreeCAD actually displays this information to the user, the pseudo-code is: 

for command in commands:
    resources = command.GetResources()
    menu_text = translate(resources['MenuText'])

In this case, lupdate cannot extract any string from the call to translate() because it refers to a variable. So lupdate ignores that call, but at runtime Qt searches for the string that's passed to it. As long as someplace in the code there is a call to one of the translation functions with a matching literal string (in this case, in the GetResources() function), this translation call will succeed.

To verify that the expected strings are being extracted, you can manually run the pylupdate command: 

pylupdate myfile.py -ts outfile.ts

The file outfile.ts will contain the set of strings that are uploaded to CrowdIn for translation.

Wichtige Verweise

Verwandte Seiten


Anwenderdokumentation